<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>websocket::stream::async_close</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
<link rel="up" href="../boost__beast__websocket__stream.html" title="websocket::stream">
<link rel="prev" href="async_accept_ex/overload3.html" title="websocket::stream::async_accept_ex (3 of 3 overloads)">
<link rel="next" href="async_handshake.html" title="websocket::stream::async_handshake">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="async_accept_ex/overload3.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__websocket__stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_handshake.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="beast.ref.boost__beast__websocket__stream.async_close"></a><a class="link" href="async_close.html" title="websocket::stream::async_close">websocket::stream::async_close</a>
</h5></div></div></div>
<p>
          <a class="indexterm" name="idp136315616"></a>
Start an asynchronous operation to send a WebSocket
          close frame.
        </p>
<h6>
<a name="beast.ref.boost__beast__websocket__stream.async_close.h0"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.async_close.synopsis"></a></span><a class="link" href="async_close.html#beast.ref.boost__beast__websocket__stream.async_close.synopsis">Synopsis</a>
        </h6>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">class</span> <span class="identifier">CloseHandler</span><span class="special">&gt;</span>
<a href="../../../../../../../doc/html/boost_asio/reference/asynchronous_operations/automatic_deduction_of_initiating_function_return_type.html" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a>
<span class="identifier">async_close</span><span class="special">(</span>
    <span class="identifier">close_reason</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">cr</span><span class="special">,</span>
    <span class="identifier">CloseHandler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span><span class="special">);</span>
</pre>
<h6>
<a name="beast.ref.boost__beast__websocket__stream.async_close.h1"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.async_close.description"></a></span><a class="link" href="async_close.html#beast.ref.boost__beast__websocket__stream.async_close.description">Description</a>
        </h6>
<p>
          This function is used to asynchronously send a close frame on the stream.
          This function call always returns immediately. The asynchronous operation
          will continue until one of the following conditions is true:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              The close frame finishes sending.
            </li>
<li class="listitem">
              An error occurs on the stream.
            </li>
</ul></div>
<p>
          This operation is implemented in terms of one or more calls to the next
          layer's <code class="computeroutput"><span class="identifier">async_write_some</span></code>
          functions, and is known as a <span class="emphasis"><em>composed operation</em></span>. The
          program must ensure that the stream performs no other write operations
          (such as <a class="link" href="async_ping.html" title="websocket::stream::async_ping"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">async_ping</span></code></a>, <a class="link" href="async_write.html" title="websocket::stream::async_write"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">async_write</span></code></a>, <a class="link" href="async_write_some.html" title="websocket::stream::async_write_some"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">async_write_some</span></code></a>, or <a class="link" href="async_close.html" title="websocket::stream::async_close"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">async_close</span></code></a>) until this operation
          completes.
        </p>
<p>
          If the close reason specifies a close code other than beast::websocket::close_code::none,
          the close frame is sent with the close code and optional reason string.
          Otherwise, the close frame is sent with no payload.
        </p>
<p>
          Callers should not attempt to write WebSocket data after initiating the
          close. Instead, callers should continue reading until an error occurs.
          A read returning <a class="link" href="../boost__beast__websocket__error.html" title="websocket::error"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">closed</span></code></a> indicates a successful
          connection closure.
        </p>
<h6>
<a name="beast.ref.boost__beast__websocket__stream.async_close.h2"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.async_close.parameters"></a></span><a class="link" href="async_close.html#beast.ref.boost__beast__websocket__stream.async_close.parameters">Parameters</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">cr</span></code>
                  </p>
                </td>
<td>
                  <p>
                    The reason for the close.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">handler</span></code>
                  </p>
                </td>
<td>
                  <p>
                    Invoked when the operation completes. The handler may be moved
                    or copied as needed. The function signature of the handler must
                    be:
                  </p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
    <span class="identifier">error_code</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">ec</span>     <span class="comment">// Result of operation</span>
<span class="special">);</span>
</pre>
                  <p>
                    Regardless of whether the asynchronous operation completes immediately
                    or not, the handler will not be invoked from within this function.
                    Invocation of the handler will be performed in a manner equivalent
                    to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_context</span><span class="special">::</span><span class="identifier">post</span></code>.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2016, 2017 Vinnie Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="async_accept_ex/overload3.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__websocket__stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_handshake.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
